home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_hylafax.idb / usr / freeware / catman / u_man / cat1 / faxwatch.Z / faxwatch
Text File  |  2002-07-08  |  6KB  |  132 lines
  1. FAXWATCH(${MANNUM1_8})               FAXWATCH(${MANNUM1_8})
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        faxwatch    - monitor low-level _H_y_l_a_F_A_X server actions
  7.  
  8. SSYYNNOOPPSSIISS
  9.        $${{SSBBIINN}}//ffaaxxwwaattcchh    [ --gg ] [ --ll ] [    --hh _h_o_s_t    ] _t_r_i_g_g_e_r_-_e_x_p_r_e_s_
  10.        _s_i_o_n
  11.  
  12. DDEESSCCRRIIPPTTIIOONN
  13.        _f_a_x_w_a_t_c_h    registers interest in one or  more  events  on    a
  14.        _H_y_l_a_F_A_X    server    and then prints    subsequent event messages
  15.        to the standard output.    The _f_a_x_w_a_t_c_h program is     intended
  16.        mainly  for  testing the    event distribution mechanism used
  17.        by the _H_y_l_a_F_A_X servers.
  18.  
  19.        The _t_r_i_g_g_e_r_-_e_x_p_r_e_s_s_i_o_n is supplied as  an  argument  to    a
  20.        ``SITE TRIGGER''    command    passed to the _h_f_a_x_d(${MANNUM1_8})
  21.        The syntax for this expression is:
  22.  
  23.           [<_c_l_a_s_s>['<'_i_d'>'][<_m_a_s_k>|'*']]*
  24.  
  25.        where <_c_l_a_s_s> defines a class of    events and is one of:
  26.  
  27.        JJ      for job-related events,
  28.  
  29.        SS      for fax send-related events,
  30.  
  31.        RR      for fax receive-related events, and
  32.  
  33.        MM      for modem-related    events.
  34.  
  35.        A <_m_a_s_k>    is a 4-hex-digit mask of trigger events    (see  the
  36.        table  below).    If  ``*'' is specified then all    events in
  37.        the class are matched.
  38.  
  39.        An <_i_d> can be used to restrict matches to a specific  job
  40.        or modem.  Eventually this will need to be generalized for
  41.        job groups.
  42.  
  43.        Thus an example specification that would    catch  any  event
  44.        for  the     modem on ttyf2    would be ``M<ttyf2>*'',    and to be
  45.        notified    when job 1932 is requeued or completes one  would
  46.        use ``J<1932>4c60''.
  47.  
  48.        The output from _f_a_x_w_a_t_c_h    is ASCII text that describes each
  49.        event.  _f_a_x_w_a_t_c_h    runs until it is interrupted.
  50.  
  51. OOPPTTIIOONNSS
  52.        --gg     Display times and dates in Greenwich  Mean  Time
  53.          (GMT).     NB: _t_h_i_s _i_s _t_h_e _d_e_f_a_u_l_t.
  54.  
  55.        --hh _h_o_s_t     Report     the  status  of the server on a specific
  56.          _h_o_s_t.    The _h_o_s_t may be    either a symbolic name or
  57.          a network address.  If    no --hh option is    supplied,
  58.          _f_a_x_w_a_t_c_h uses the FAXSERVER environment variable
  59.          to  identify  the _H_y_l_a_F_A_X server to contact.  If
  60.          this variable is not set, then     _f_a_x_w_a_t_c_h  checks
  61.          for  a    setting    in the configuration files (first
  62.          in the    per-user file and then in the system-wide
  63.          file).     If all    of the above fails, then _f_a_x_w_a_t_c_h
  64.          attempts to contact  a     server     on  the  machine
  65.          where it is run.
  66.  
  67.        --ll     Display times and dates in the    local timezone of
  68.          the server.
  69.  
  70.        --vv     Trace the protocol  exchanges    between     _f_a_x_w_a_t_c_h
  71.          and  the _h_f_a_x_d    processes on the standard output.
  72.  
  73. EEVVEENNTTSS
  74.        The following table specifies the current  set  of  events
  75.        that  may  be  monitored.   This    information is subject to
  76.        change; consult the source code for reference.
  77.  
  78.        EEvveenntt            CCllaassss  MMaasskk          DDeessccrriippttiioonn
  79.        JOB_CREATE        J       0x0001     job created
  80.        JOB_SUSPEND        J       0x0002     job suspended
  81.        JOB_READY        J       0x0004     job ready    to send
  82.        JOB_SLEEP        J       0x0008     job sleeping awaiting time-to-send
  83.        JOB_DEAD            J       0x0010     job marked dead
  84.        JOB_PROCESS        J       0x0020     job processed by scheduler
  85.        JOB_REAP            J       0x0040     job corpus reaped
  86.        JOB_ACTIVE        J       0x0080     job activated
  87.        JOB_REJECT        J       0x0100     job rejected
  88.        JOB_KILL            J       0x0200     job killed
  89.        JOB_BLOCKED        J       0x0400     job blocked by other job
  90.        JOB_DELAYED        J       0x0800     job delayed by tod restriction or    similar
  91.        JOB_ALTERED       J      0x1000     job parameters altered
  92.        JOB_TIMEDOUT        J       0x2000     job kill timer expired
  93.        JOB_PREP_BEGIN        J       0x4000     job preparation started
  94.        JOB_PREP_END        J       0x8000     job preparation finished
  95.        SEND_BEGIN        S       0x0001     fax, send    attempt    started
  96.        SEND_CALL        S       0x0002     fax, call    placed
  97.        SEND_CONNECTED        S       0x0004     fax, call    answered by fax
  98.        SEND_PAGE        S       0x0008     fax, page    transmit done
  99.        SEND_DOC            S       0x0010     fax, document transmit done
  100.        SEND_POLLRCVD        S       0x0020     fax, document retrieved by poll operation
  101.        SEND_POLLDONE        S       0x0040     fax, poll    operation completed
  102.        SEND_END            S       0x0080     fax, send    attempt    finished
  103.        SEND_REFORMAT        S       0x0100     fax, job being reformatted
  104.        SEND_REQUEUE        S       0x0200     fax, job requeued
  105.        SEND_DONE        S       0x0400     fax, send    job done
  106.        RECV_BEGIN        R       0x0001     fax, inbound call    started
  107.        RECV_START        R       0x0002     fax, session started
  108.        RECV_PAGE        R       0x0004     fax, page    receive    done
  109.        RECV_DOC            R       0x0008     fax, document receive done
  110.        RECV_END            R       0x0010     fax, inbound call    finished
  111.        MODEM_ASSIGN        M       0x0001     modem assigned to    job
  112.        MODEM_RELEASE        M       0x0002     modem released by    job
  113.        MODEM_DOWN        M       0x0004     modem marked down
  114.        MODEM_READY        M       0x0008     modem marked ready
  115.        MODEM_BUSY        M       0x0010     modem marked busy
  116.        MODEM_WEDGED        M       0x0020     modem considered wedged
  117.        MODEM_INUSE        M       0x0040     modem inuse for outbound work
  118.        MODEM_DATA_BEGIN        M       0x0080     inbound data call    begun
  119.        MODEM_DATA_END        M       0x0100     inbound data call    finished
  120.        MODEM_VOICE_BEGIN    M       0x0200     inbound voice call begun
  121.        MODEM_VOICE_END        M       0x0400     inbound voice call finished
  122.        MODEM_CID        M       0x0800     inbound caller-ID    information
  123.  
  124.     Event to be removed soon.
  125.  
  126. SSEEEE AALLSSOO
  127.        _h_y_l_a_f_a_x_-_s_e_r_v_e_r(${MANNUM4_5}), _h_f_a_x_d(${MANNUM1_8}).
  128.  
  129.  
  130.  
  131.              January 18, 1996  FAXWATCH(${MANNUM1_8})
  132.